<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>YUI Library Examples: ProgressBar Control: Events</title>
    

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >

<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
</style>

<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/slider/assets/skins/sam/slider.css" />
<link rel="stylesheet" type="text/css" href="../../build/progressbar/assets/skins/sam/progressbar.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/animation/animation-min.js"></script>
<script type="text/javascript" src="../../build/dragdrop/dragdrop-min.js"></script>
<script type="text/javascript" src="../../build/slider/slider-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/progressbar/progressbar-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>


<!--begin custom header content for this example-->
<style type="text/css">
.example-container .bd {
    overflow:hidden;
}

#containers {
	float:left;
	margin-top:2em;
}


#textContainers {
	overflow:hidden;
	width:200px;
	position: absolute; /* for ie7 and ie8 */
}

#minValueContainer {
	float:left;
}

#maxValueContainer {
	float:right;
}

#status {
	text-align:center;
}

#pbContainer .yui-pb-bar {
	background-color: rgb(127,127,127);
	background-image: none;
}

#control {
	float:right;
	width:300px;
	*margin-top:2em;
}

/* start ie workaround */
fieldset {
	border: thin solid silver;
	background-color:#F0F0F0;
	padding:1em;
	margin:1em;

	*position: relative;
	*margin: 0 0 1em 0;
    *padding-top:2em;
}

fieldset p {
	margin:0 1em;
}

legend {
	font-weight:bold;
	margin:0 0.5em;
	padding:0 0.2em;

	*position:absolute;
    *top: -.5em;
    *left: .5em;
}
/* end ie workaround */

.dp-highlighter th, .dp-highlighter td {
	border:0;
	padding:0;
}
.dp-highlighter .line1, .dp-highlighter  .line2 {
	padding-left:10px;
	white-space:nowrap;
}
</style>

<!--end custom header content for this example-->


<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
	YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class="yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
	<div id="ygunav">
		<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
		<form action="http://search.yahoo.com/search" id="sitesearchform">
		<input name="vs" type="hidden" value="developer.yahoo.com">
		<input name="vs" type="hidden" value="yuiblog.com">
		<div id="sitesearch">
			<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
			<input type="text" id="searchinput" name="p">
			<input type="submit" value="Search" id="searchsubmit" class="ygbt">
		</div>
		</form>	</div>
	<div id="ygma"><a href="../../"><img src="../../assets/yui.gif"  border="0" height="38"></a></div>
	<div id="pagetitle"><h1>YUI Library Examples: ProgressBar Control: Events</h1></div>
</div>
<div id="bd">
	
	<div id="yui-main">
		<div class="yui-b">
		  <div class="yui-ge">
			  <div class="yui-u first example">

    
	<div class="promo">
	<h1>ProgressBar Control: Events</h1>
	
	<div class="exampleIntro">
	<p>This example shows how you can use the events that ProgressBar fires.</p>
			
	</div>	
					
	<div class="example-container module ">
			<div class="hd exampleHd">
			<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="pb_events_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->		
		</div>		<div id="example-canvas" class="bd">
	
		
	<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
	
	<div id="containers">
	<div id="pbContainer"></div>
	<div id="textContainers">
		<div id="minValueContainer" class="yui-pb-range">0</div>
		<div id="maxValueContainer" class="yui-pb-range">255</div>
		<div class="yui-pb-caption">
			<span id="valueContainer">127</span>
			<span id="status"></span>
		</div>
	</div>
</div>
<fieldset id="control">
	<legend>Control</legend>
	<fieldset id="valueSet">
		<legend>Value</legend>
		<div id="sliderValue" class="yui-h-slider" tabindex="-1" title="Value slider">
			<div id="sliderValueThumb" class="yui-slider-thumb"><img src="../progressbar/assets/thumb-n.gif"></div>
		</div>
	</fieldset>
	<fieldset id="rangeSet">
		<legend>Range</legend>
		<div id="sliderRange" class="yui-h-slider" title="Range slider">
			<div id="sliderRangeMinThumb" class="yui-slider-thumb"><img src="../progressbar/assets/thumb-e.gif"></div>
			<div id="sliderRangeMaxThumb" class="yui-slider-thumb"><img src="../progressbar/assets/thumb-w.gif"></div>
		</div>
	</fieldset>
</fieldset>

<script type="text/javascript">
// Workaround for bug #2528312
//YAHOO.widget.Slider.prototype.baselinePos = [];

YAHOO.util.Event.onDOMReady( function () {
	var Dom = YAHOO.util.Dom;

	var pb = new YAHOO.widget.ProgressBar({
		value:127,
		maxValue:255,
		anim:true
	}).render('pbContainer');
	var anim = pb.get('anim');
	anim.duration = 3;
	anim.method = YAHOO.util.Easing.bounceBoth;

	pb.on('start',function (value) {
		Dom.get('status').innerHTML = 'Started';
		window.setTimeout(function() {
			Dom.get('status').innerHTML = '';
		},1000);
	});

	pb.on('progress',function (value) {
		Dom.setStyle(this.get('barEl'),'backgroundColor','rgb(' + value + ',' + value + ',127)');
		Dom.get('valueContainer').innerHTML = value;
	});

	pb.on('complete',function (value) {
		Dom.get('status').innerHTML = 'Stopped';
		window.setTimeout(function() {
			Dom.get('status').innerHTML = '';
		},1000);
	});

	pb.on('minValueChange',function(oArgs)  {
		Dom.get('minValueContainer').innerHTML = oArgs.newValue;
	});

	pb.on('maxValueChange',function(oArgs)  {
		Dom.get('maxValueContainer').innerHTML = oArgs.newValue;
	});

	// From here on, it is mostly handling of the Sliders

	var valueSlider = YAHOO.widget.Slider.getHorizSlider('sliderValue',
        'sliderValueThumb', 0, 200, 0
	);
	valueSlider.setValue(100,true,true,true);
	valueSlider.animate = false;

	var valueScale = 1.275, minValue = 0;

	valueSlider.subscribe("slideEnd", function() {
		var value = Math.round(valueSlider.getValue() * valueScale + minValue);
		pb.set('value',value);
		window.setTimeout(function() {
			valueSlider.setValue((pb.get('value') - minValue)/ valueScale,true,true,true);
		},1);
	});

	var rangeSlider = YAHOO.widget.Slider.getHorizDualSlider("sliderRange",
        "sliderRangeMinThumb", "sliderRangeMaxThumb",
        200, 0, [0, 200]
	);

	rangeSlider.animate = false;

	rangeSlider.subscribe('slideEnd', function() {
		minValue = Math.round(this.minVal * 1.275);
		pb.set('minValue',minValue);
		var maxValue = Math.round(this.maxVal * 1.275);
		pb.set('maxValue',maxValue);
		valueScale = (maxValue - minValue) / 200;
		valueSlider.setValue((pb.get('value') - minValue) / valueScale,true,true,true);
	});

});
</script>
	
	<!--END SOURCE CODE FOR EXAMPLE =============================== -->
	
		
		</div>
		
	
	</div>			
	</div>
		
	<p>The code to create the ProgressBar is:</p>
<textarea name="code" class="JScript" cols="60" rows="1">
	var pb = new YAHOO.widget.ProgressBar({
		value:127,
		maxValue:255,
		anim:true
	}).render('pbContainer');
	var anim = pb.get('anim');
	anim.duration = 3;
	anim.method = YAHOO.util.Easing.bounceBoth;

</textarea>
<p>We instantiate the ProgressBar and configure it so that the initial value is 127, which is halfway
between 0 and 255. We chose this range so that the values can translate directly into color values,
which we then apply to the bar. The ProgressBar uses an Animation instance which we can get and access
directly to set its duration and easing method.</p>

<p>We are listening to the three events related to movement:</p>
<ul>
<li><code>start</code> signals the start of the movement</li>
<li><code>progress</code> is fired during the movement</li>
<li><code>complete</code> signals the completion of the movement</li>
</ul>


<p>Without animation, the <code>start</code>, <code>progress</code>
and <code>complete</code> events fire one after the other in close sequence.</p>

<textarea name="code" class="JScript" cols="60" rows="1">
	pb.on('start',function (value) {
		Dom.get('status').innerHTML = 'Started';
		window.setTimeout(function() {
			Dom.get('status').innerHTML = '';
		},1000);
	});

	pb.on('progress',function (value) {
		Dom.setStyle(this.get('barEl'),'backgroundColor','rgb(' + value + ',' + value + ',127)');
		Dom.get('valueContainer').innerHTML = value;
	});

	pb.on('complete',function (value) {
		Dom.get('status').innerHTML = 'Stopped';
		window.setTimeout(function() {
			Dom.get('status').innerHTML = '';
		},1000);
	});
</textarea>

<p>Our event handlers do a few simple things:</p>

<ul>
<li>we display 'Started' for one second upon receiving the <code>start</code> event</li>
<li>we change the color of the bar itself to reflect the <code>value</code> received from the <code>progress</code> event</li>
<li>we show the current value right below the bar (all events provide the <code>value</code>)</li>
<li>we display 'Stopped' upon receiving the <code>complete</code> event</li>
</ul>

<p>The <code>value</code> argument passed by all events provides the nominal value of the ProgresBar, not the size of the bar itself.
A value of 50 will always be halfway in a range of 0 to 100, whether the ProgressBar is 100 or 500 pixels wide.</p>

<p>We have also provided a slider to change the end values for the bar so that we can show how to respond to those
events and display their values. The ProgressBar inherits the attribute change events
from the <a href="http://developer.yahoo.com/yui/element/">Element Utility</a>, so before and after change events are available for all configuration attributes.</p>
<textarea name="code" class="JScript" cols="60" rows="1">
	pb.on('minValueChange',function(oArgs)  {
		Dom.get('minValueContainer').innerHTML = oArgs.newValue;
	});

	pb.on('maxValueChange',function(oArgs)  {
		Dom.get('maxValueContainer').innerHTML = oArgs.newValue;
	});
</textarea>
<p>The markup for the text labels are shown below.  Notice the <code>yui-pb-range</code> and <code>yui-pb-caption</code>
class names in their declaration.  The ProgressBar itself does not use those class names at all, but they are defined as part of the "Sam"
skin as a convenience to the implementer.</p>
<textarea name="code" class="HTML" cols="60" rows="1">
	<div id="textContainers">
		<div id="minValueContainer" class="yui-pb-range">0</div>
		<div id="maxValueContainer" class="yui-pb-range">255</div>
		<div class="yui-pb-caption">
			<span id="valueContainer">127</span>
			<span id="status"></span>
		</div>
	</div>
</textarea>

<h2>Configuration for This Example</h2>

<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers.  <a href="http://developer.yahoo.com/yui/articles/hosting/?animation&slider&progressbar&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>

				</div>
				<div class="yui-u">
						<div id="loggerModule" class="yui-skin-sam">
						<h3 class="firstContent">YUI Logger Output:</h3>
								<div id="loggerGloss"><p><strong>Note:</strong> Logging and debugging is currently turned off for this example.</p> 
							<p class="loggerButton"><span id="loggerLink"><span class="first-child"><a href="pb_events_log.html">Reload with logging<br />
	 and debugging enabled.</a></span></span></p></div>
	
						</div>
					
				
					<div id="examples">
						<h3>ProgressBar Control Examples:</h3>
	
						<div id="exampleToc">
							<ul>
								<li><a href='../progressbar/pb_basic.html'>Basic Features</a></li><li class='selected'><a href='../progressbar/pb_events.html'>Events</a></li><li><a href='../progressbar/pb_ratings.html'>Ratings</a></li><li><a href='../progressbar/pb_vumeter.html'>VU Meters</a></li>							</ul>
						</div>
					</div>
					
					<div id="module">
						<h3>More ProgressBar Control Resources:</h3>
						<ul>
							<li><a href="http://developer.yahoo.com/yui/progressbar/">User's Guide</a> (external)</li>
						<li><a href="../../docs/module_progressbar.html">API Documentation</a></li>
                            
                            
							<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/progressbar.pdf">Cheat Sheet PDF</a> (external)</li></ul>
					</div>
			  </div>
		</div>
		
		</div>
	</div>


<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
	
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="selected "><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
	</div><!--closes bd-->

	<div id="ft">
        <p class="first">Copyright &copy; 2011 Yahoo! Inc. All rights reserved.</p>
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
	</div>
</div>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript"> 
dp.SyntaxHighlighter.HighlightAll('code'); 
</script>

<script src='../../assets/YUIexamples.js'></script>


</body>
</html>
